proper formatting
Umar M. Sheikh
1 changed files with 9 additions and 8 deletions
+ 9
- 8
app/models/agents/public_transport_agent.rb
@@ -5,14 +5,15 @@ module Agents |
||
| 5 | 5 |
cannot_receive_events! |
| 6 | 6 |
description <<-MD |
| 7 | 7 |
Specify the following user settings: |
| 8 |
- - stops (array) |
|
| 9 |
- - agency (string) |
|
| 10 |
- - alert_window_in_minutes (integer) |
|
| 11 | 8 |
|
| 12 |
- This Agent generates Events based on NextBus GPS transit predictions. First, select an agency by visiting http://www.nextbus.com/predictor/agencySelector.jsp and finding your transit system. Once you find it, copy the part of the URL after `?a=`. For example, for the San Francisco MUNI system, you would end up on http://www.nextbus.com/predictor/stopSelector.jsp?a=sf-muni and copy "sf-muni". Put that into this Agent's agency setting. |
|
| 9 |
+ * stops (array) |
|
| 10 |
+ * agency (string) |
|
| 11 |
+ * alert_window_in_minutes (integer) |
|
| 12 |
+ |
|
| 13 |
+ This Agent generates Events based on NextBus GPS transit predictions. First, select an agency by visiting [http://www.nextbus.com/predictor/agencySelector.jsp](http://www.nextbus.com/predictor/agencySelector.jsp) and finding your transit system. Once you find it, copy the part of the URL after `?a=`. For example, for the San Francisco MUNI system, you would end up on [http://www.nextbus.com/predictor/stopSelector.jsp?a=**sf-muni**](http://www.nextbus.com/predictor/stopSelector.jsp?a=sf-muni) and copy "sf-muni". Put that into this Agent's agency setting. |
|
| 13 | 14 |
|
| 14 | 15 |
Next, find the stop tags that you care about. To find the tags for the sf-muni system, for the N route, visit this URL: |
| 15 |
- http://webservices.nextbus.com/service/publicXMLFeed?command=routeConfig&a=sf-muni&r=N |
|
| 16 |
+ [http://webservices.nextbus.com/service/publicXMLFeed?command=routeConfig&a=sf-muni&r=**N**](http://webservices.nextbus.com/service/publicXMLFeed?command=routeConfig&a=sf-muni&r=N) |
|
| 16 | 17 |
|
| 17 | 18 |
The tags are listed as tag="1234". Copy that number and add the route before it, separated by a pipe '|' symbol. Once you have one or more tags from that page, add them to this Agent's stop list. E.g, |
| 18 | 19 |
|
@@ -21,13 +22,13 @@ module Agents |
||
| 21 | 22 |
|
| 22 | 23 |
This Agent will generate predictions by requesting a URL similar to the following: |
| 23 | 24 |
|
| 24 |
- http://webservices.nextbus.com/service/publicXMLFeed?command=predictionsForMultiStops&a=sf-muni&stops=N|5221&stops=N|5215 |
|
| 25 |
+ [http://webservices.nextbus.com/service/publicXMLFeed?command=predictionsForMultiStops&a=sf-muni&stops=N|5221&stops=N|5215](http://webservices.nextbus.com/service/publicXMLFeed?command=predictionsForMultiStops&a=sf-muni&stops=N|5221&stops=N|5215) |
|
| 25 | 26 |
|
| 26 | 27 |
Finally, set the arrival window that you're interested in. E.g., 5 minutes. Events will be created by the agent anytime a new train or bus comes into that time window. |
| 27 | 28 |
|
| 28 |
- alert_window_in_minutes: 5 |
|
| 29 |
+ alert_window_in_minutes: 5 |
|
| 29 | 30 |
|
| 30 |
- This memory should get cleaned up when timestamp is older than an hour (or something) so that it doesn't fill up all of the Agent's memory. |
|
| 31 |
+ This memory should get cleaned up when timestamp is older than an hour (or something) so that it doesn't fill up all of the Agent's memory. |
|
| 31 | 32 |
MD |
| 32 | 33 |
|
| 33 | 34 |
|